docs: Cover corner-case of @line_number = total lines in buffer
authorAvinash Sonawane <rootkea@gmail.com>
Tue, 30 Mar 2021 11:17:33 +0000 (16:47 +0530)
committerAvinash Sonawane <rootkea@gmail.com>
Tue, 30 Mar 2021 11:30:33 +0000 (17:00 +0530)
gtk/gtktextbuffer.c
gtk/gtktextiter.c

index 6f2fd5534a6f0152959e8fd00e1035d1a9ff1a9d..40faef526db7b70f3a6307469eee226537cc94a5 100644 (file)
@@ -3250,7 +3250,7 @@ gtk_text_buffer_remove_all_tags (GtkTextBuffer     *buffer,
  * Note characters, not bytes; UTF-8 may encode one character as multiple
  * bytes.
  *
- * If @line_number is greater than the number of lines in the @buffer,
+ * If @line_number is greater than or equal to the number of lines in the @buffer,
  * the end iterator is returned. And if @char_offset is off the
  * end of the line, the iterator at the end of the line is returned.
  *
@@ -3301,7 +3301,7 @@ gtk_text_buffer_get_iter_at_line_offset (GtkTextBuffer *buffer,
  * @byte_index must be the start of a UTF-8 character. Note bytes, not
  * characters; UTF-8 may encode one character as multiple bytes.
  *
- * If @line_number is greater than the number of lines in the @buffer,
+ * If @line_number is greater than or equal to the number of lines in the @buffer,
  * the end iterator is returned. And if @byte_index is off the
  * end of the line, the iterator at the end of the line is returned.
  *
@@ -3348,7 +3348,7 @@ gtk_text_buffer_get_iter_at_line_index  (GtkTextBuffer *buffer,
  *
  * Initializes @iter to the start of the given line.
  *
- * If @line_number is greater than the number of lines
+ * If @line_number is greater than or equal to the number of lines
  * in the @buffer, the end iterator is returned.
  *
  * Returns: whether the exact position has been found
index 24e25d9d855cc274c92f6f0731c17723fe44ccd2..98681105687cf97e2c0e689aa1b75429bc078b83 100644 (file)
@@ -4052,7 +4052,7 @@ gtk_text_iter_set_visible_line_index (GtkTextIter *iter,
  *
  * Moves iterator @iter to the start of the line @line_number.
  *
- * If @line_number is negative or larger than the number of lines
+ * If @line_number is negative or larger than or equal to the number of lines
  * in the buffer, moves @iter to the start of the last line in the buffer.
  */
 void